docs(maintainers): add style guide for input and output#422
Conversation
zimeg
added
the
code health
zimeg
added
the
semver:patch
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #422 +/- ##
==========================================
- Coverage 69.72% 69.71% -0.02%
==========================================
Files 220 220
Lines 18446 18446
==========================================
- Hits 12862 12859 -3
- Misses 4410 4411 +1
- Partials 1174 1176 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
mwbrooks
left a comment
mwbrooks
left a comment
There was a problem hiding this comment.
✅ Awesome start and just the right depth. There's no need to apologize about it being sparse because this PR is about creating the Style Guide and not writing it's content. If there was more content, we'd end up noodling over the details instead of merging it immediately 🚀
💅🏻 The Prompt Input is a great topic to start with since it's top-of-mind!
| ## Style Guide | ||
|
|
||
| See [`.github/STYLE_GUIDE.md`](../.github/STYLE_GUIDE.md) for conventions on command inputs and outputs. | ||
|
|
There was a problem hiding this comment.
praise: Awesome way to reference Claude into it.
There was a problem hiding this comment.
@mwbrooks Let's hope to reduce a turn or two with this 😉
👾 ramble: We did consider using the @../.github/STYLE_GUIDE.md syntax but didn't want to load this into context for unrelated tasks. It's an alright skill perhaps?
|
@mwbrooks Thanks for the confidence in this introduction 🐝 ✨ I'm both optimistic and excited for the direction things might be heading in so let's merge this quick to keep onward! 🍯 |
2 participants
Changelog
Summary
This PR adds a
STYLE_GUIDE.mdfor common input and output patterns we're hoping to match- 🎨 📺Notes
The current page is somewhat sparse but might be updated as confusion is found in ongoing change!
Requirements